<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>content.Class | My Python Project</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">My Python Project</a>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          <span class="m-breadcrumb"><a href="content.html">content</a>.<wbr/></span>Class <span class="m-thin">class</span>
        </h1>
        <p>This overwrites the docstring for <a class="m-doc" href="content.Class.html">Class</a>.</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#classmethods">Class methods</a></li>
                <li><a href="#staticmethods">Static methods</a></li>
                <li><a href="#methods">Methods</a></li>
                <li><a href="#dunder-methods">Special methods</a></li>
                <li><a href="#properties">Properties</a></li>
                <li><a href="#data">Data</a></li>
              </ul>
            </li>
          </ul>
        </nav>
<p>This is detailed class docs. Here I <em>also</em> hate how it needs to be
indented.</p>
        <section id="classmethods">
          <h2><a href="#classmethods">Class methods</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#class_method" class="m-doc">class_method</a>(</span><span class="m-doc-wrap">b)</span>
            </dt>
            <dd>This function is a class method</dd>
          </dl>
        </section>
        <section id="staticmethods">
          <h2><a href="#staticmethods">Static methods</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#static_method" class="m-doc">static_method</a>(</span><span class="m-doc-wrap">cls, a)</span>
            </dt>
            <dd>This function is a static method</dd>
          </dl>
        </section>
        <section id="methods">
          <h2><a href="#methods">Methods</a></h2>
          <dl class="m-doc">
            <dt id="method">
              <span class="m-doc-wrap-bumper">def <a href="#method" class="m-doc-self">method</a>(</span><span class="m-doc-wrap">self)</span>
            </dt>
            <dd>This overwrites the docstring for <a class="m-doc" href="content.Class.html#method">method()</a>, but doesn't
add any detailed block.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#method_param_docs" class="m-doc">method_param_docs</a>(</span><span class="m-doc-wrap">self, a, b)</span>
            </dt>
            <dd>This method gets its params except self documented</dd>
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#method_param_exception_return_docs" class="m-doc">method_param_exception_return_docs</a>(</span><span class="m-doc-wrap">self, a, b)</span>
            </dt>
            <dd>This one documents params and raised exceptions</dd>
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#method_with_details" class="m-doc">method_with_details</a>(</span><span class="m-doc-wrap">self)</span>
            </dt>
            <dd></dd>
          </dl>
        </section>
        <section id="dunder-methods">
          <h2><a href="#dunder-methods">Special methods</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">def <a href="#__init__" class="m-doc">__init__</a>(</span><span class="m-doc-wrap">self)</span>
            </dt>
            <dd>A dunder method</dd>
          </dl>
        </section>
        <section id="properties">
          <h2><a href="#properties">Properties</a></h2>
          <dl class="m-doc">
            <dt id="a_property">
              <a href="#a_property" class="m-doc-self">a_property</a> <span class="m-label m-flat m-warning">get</span>
            </dt>
            <dd>This overwrites the docstring for <a class="m-doc" href="content.Class.html#a_property">a_property</a>, but doesn't
add any detailed block.</dd>
            <dt>
              <a href="#a_property_with_details" class="m-doc">a_property_with_details</a> <span class="m-label m-flat m-warning">get</span>
            </dt>
            <dd>This overwrites the docstring for <a class="m-doc" href="content.Class.html#a_property_with_details">a_property_with_details</a>.</dd>
            <dt>
              <a href="#annotated_property" class="m-doc">annotated_property</a>: float <span class="m-label m-flat m-warning">get</span>
            </dt>
            <dd>This is an annotated property</dd>
            <dt>
              <a href="#property_exception_docs" class="m-doc">property_exception_docs</a> <span class="m-label m-flat m-warning">get</span>
            </dt>
            <dd>This one documents raised exceptions in an (otherwise unneeded)
detail view</dd>
          </dl>
        </section>
        <section id="data">
          <h2><a href="#data">Data</a></h2>
          <dl class="m-doc">
            <dt>
              <a href="#DATA_WITH_DETAILS" class="m-doc">DATA_WITH_DETAILS</a>: str = &#x27;this blows&#x27;
            </dt>
            <dd></dd>
          </dl>
        </section>
        <section>
          <h2>Method documentation</h2>
          <section class="m-doc-details" id="class_method"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def content.<wbr />Class.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#class_method" class="m-doc-self">class_method</a>(</span><span class="m-doc-wrap">b) <span class="m-label m-success">classmethod</span></span></span>
            </h3>
            <p>This function is a class method</p>
<p>The <span class="m-label m-success">classmethod</span> should be shown here.</p>
          </div></section>
          <section class="m-doc-details" id="static_method"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def content.<wbr />Class.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#static_method" class="m-doc-self">static_method</a>(</span><span class="m-doc-wrap">cls, a) <span class="m-label m-info">staticmethod</span></span></span>
            </h3>
            <p>This function is a static method</p>
<p>The <span class="m-label m-info">staticmethod</span> should be shown here.</p>
          </div></section>
          <section class="m-doc-details" id="method_param_docs"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def content.<wbr />Class.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#method_param_docs" class="m-doc-self">method_param_docs</a>(</span><span class="m-doc-wrap">self, a, b)</span></span>
            </h3>
            <p>This method gets its params except self documented</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">a</td>
                  <td>The first parameter</td>
                </tr>
                <tr>
                  <td>b</td>
                  <td>The second parameter</td>
                </tr>
              </tbody>
            </table>
<p>The <code>self</code> isn't documented and thus also not included in the list.</p>
          </div></section>
          <section class="m-doc-details" id="method_param_exception_return_docs"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def content.<wbr />Class.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#method_param_exception_return_docs" class="m-doc-self">method_param_exception_return_docs</a>(</span><span class="m-doc-wrap">self, a, b)</span></span>
            </h3>
            <p>This one documents params and raised exceptions</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">a</td>
                  <td>The first parameter</td>
                </tr>
                <tr>
                  <td>b</td>
                  <td>The second parameter</td>
                </tr>
              </tbody>
              <thead>
                <tr><th colspan="2">Exceptions</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td>AttributeError</td>
                  <td>If you do bad things to it</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>If you don't do bad things to it</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="method_with_details"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def content.<wbr />Class.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#method_with_details" class="m-doc-self">method_with_details</a>(</span><span class="m-doc-wrap">self)</span></span>
            </h3>
<p>This one has a detailed block without any summary.</p>
          </div></section>
          <section class="m-doc-details" id="__init__"><div>
            <h3>
              <span class="m-doc-wrap-bumper">def content.<wbr />Class.<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#__init__" class="m-doc-self">__init__</a>(</span><span class="m-doc-wrap">self)</span></span>
            </h3>
            <p>A dunder method</p>
<p>A dunder method shown in the detailed view.</p>
          </div></section>
        </section>
        <section>
          <h2>Property documentation</h2>
          <section class="m-doc-details" id="a_property_with_details"><div>
            <h3>
              content.<wbr />Class.<wbr /><a href="#a_property_with_details" class="m-doc-self">a_property_with_details</a> <span class="m-label m-flat m-warning">get</span>
            </h3>
            <p>This overwrites the docstring for <a class="m-doc" href="content.Class.html#a_property_with_details">a_property_with_details</a>.</p>
<p>Detailed property docs.</p>
          </div></section>
          <section class="m-doc-details" id="annotated_property"><div>
            <h3>
              content.<wbr />Class.<wbr /><a href="#annotated_property" class="m-doc-self">annotated_property</a>: float <span class="m-label m-flat m-warning">get</span>
            </h3>
            <p>This is an annotated property</p>
<p>Annotated property, using summary from the docstring.</p>
          </div></section>
          <section class="m-doc-details" id="property_exception_docs"><div>
            <h3>
              content.<wbr />Class.<wbr /><a href="#property_exception_docs" class="m-doc-self">property_exception_docs</a> <span class="m-label m-flat m-warning">get</span>
            </h3>
            <p>This one documents raised exceptions in an (otherwise unneeded)
detail view</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Exceptions</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">AttributeError</td>
                  <td>If you do bad things to it</td>
                </tr>
              </tbody>
            </table>
          </div></section>
        </section>
        <section>
          <h2>Data documentation</h2>
          <section class="m-doc-details" id="DATA_WITH_DETAILS"><div>
            <h3>
              content.<wbr />Class.<wbr /><a href="#DATA_WITH_DETAILS" class="m-doc-self">DATA_WITH_DETAILS</a>: str
            </h3>
<p>Detailed docs for <a class="m-doc" href="content.Class.html#DATA_WITH_DETAILS">DATA_WITH_DETAILS</a> in a class to check
rendering.</p>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
</body>
</html>
